REST API for Oracle Internet of Things Cloud Service

IoT Device Resource REST Endpoints

IoT Device Resource

This resource provides set of operations and methods to manage devices, application for devices, metadata for devices and software resources for devices.

Create a new Device: Method: post

Path: /iot/api/v2/devices
Create Request to Start Deployed Software on a Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Create Request to Stop Deployed Software on Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Delete Deployed Software on a Device: Method: delete

Path: /iot/api/v2/devices/{device-id}/software/{id}
Delete Device Location: Method: delete

Path: /iot/api/v2/devices/{device-id}/location
Delete the Device by ID: Method: delete

Path: /iot/api/v2/devices/{device-id}
Deploy new Software on the Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software
Get device activation logs: Method: get

Path: /iot/api/v2/devices/{device-id}/logs/activation
Retrieve a List of Artifacts of the Repository: Method: get

Path: /iot/api/v2/devices/{device-id}/software
Retrieve a Metadata Key for the Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests/{r-id}
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests/{r-id}
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests/{r-id}
Retrieve a Start Request Status with Details by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests/{r-id}
Retrieve a Stop Request Status and Details with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests/{r-id}
Retrieve an Application by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Retrieve count of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes/count
Retrieve Count of Devices: Method: get

Path: /iot/api/v2/devices/count
Retrieve Device Details: Method: get

Path: /iot/api/v2/devices/{device-id}
Retrieve Information about Multiple Devices: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/devices
Retrieve Information about Multiple Endpoints: Method: get

Path: /iot/api/v2/devices
Retrieve Information about the Device Location: Method: get

Path: /iot/api/v2/devices/{device-id}/location
Retrieve List of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes
Retrieve List of Devices which Belong to: Method: get

Path: /iot/api/v2/devices/{device-id}/devices
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests
Retrieve Metadata for Application with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/metadata
Retrieve Metadata for Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata
Retrieve Software Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}
Retrieve the Details of a Start Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Retrieve the Details of a Stop Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Retrieve the List of Applications or Adapters: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps
Set a Metadata Value for the Provided Key for the Device with Specified Id: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Update a Device by ID: Method: post

Path: /iot/api/v2/devices/{device-id}
Update a Device Location with a new One: Method: put

Path: /iot/api/v2/devices/{device-id}/location
Update Application Details by Device Id: Method: post

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update Device Details by Application Id: Method: put

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update Device Information by ID: Method: put

Path: /iot/api/v2/devices/{device-id}
Update Device Location with New Values: Method: post

Path: /iot/api/v2/devices/{device-id}/location
Update or Delete metadata for a Device by ID: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata
Update Software on the Device: Method: put

Path: /iot/api/v2/devices/{device-id}/software/{id}

IoT Device Resource

This resource provides set of operations and methods to manage devices, application for devices, metadata for devices and software resources for devices.

Retrieve Information about Multiple Endpoints: Method: get

Path: /iot/api/v2/devices
Create a new Device: Method: post

Path: /iot/api/v2/devices
Retrieve Count of Devices: Method: get

Path: /iot/api/v2/devices/count
Retrieve List of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes
Retrieve count of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes/count
Delete the Device by ID: Method: delete

Path: /iot/api/v2/devices/{device-id}
Retrieve Device Details: Method: get

Path: /iot/api/v2/devices/{device-id}
Update a Device by ID: Method: post

Path: /iot/api/v2/devices/{device-id}
Update Device Information by ID: Method: put

Path: /iot/api/v2/devices/{device-id}
Retrieve the List of Applications or Adapters: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps
Retrieve an Application by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update Application Details by Device Id: Method: post

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update Device Details by Application Id: Method: put

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Retrieve Information about Multiple Devices: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/devices
Retrieve Metadata for Application with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/metadata
Retrieve List of Devices which Belong to: Method: get

Path: /iot/api/v2/devices/{device-id}/devices
Delete Device Location: Method: delete

Path: /iot/api/v2/devices/{device-id}/location
Retrieve Information about the Device Location: Method: get

Path: /iot/api/v2/devices/{device-id}/location
Update Device Location with New Values: Method: post

Path: /iot/api/v2/devices/{device-id}/location
Update a Device Location with a new One: Method: put

Path: /iot/api/v2/devices/{device-id}/location
Get device activation logs: Method: get

Path: /iot/api/v2/devices/{device-id}/logs/activation
Retrieve a List of Artifacts of the Repository: Method: get

Path: /iot/api/v2/devices/{device-id}/software
Deploy new Software on the Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software
Delete Deployed Software on a Device: Method: delete

Path: /iot/api/v2/devices/{device-id}/software/{id}
Retrieve Software Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}
Update Software on the Device: Method: put

Path: /iot/api/v2/devices/{device-id}/software/{id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests/{r-id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests/{r-id}
Retrieve the Details of a Start Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Create Request to Start Deployed Software on a Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Retrieve a Start Request Status with Details by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests/{r-id}
Retrieve the Details of a Stop Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Create Request to Stop Deployed Software on Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Retrieve a Stop Request Status and Details with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests/{r-id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests/{r-id}
Retrieve Metadata for Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata
Update or Delete metadata for a Device by ID: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata
Retrieve a Metadata Key for the Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Set a Metadata Value for the Provided Key for the Device with Specified Id: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}

IoT Device Resource

This resource provides set of operations and methods to manage devices, application for devices, metadata for devices and software resources for devices.

Delete the Device by ID: Method: delete

Path: /iot/api/v2/devices/{device-id}
Delete Device Location: Method: delete

Path: /iot/api/v2/devices/{device-id}/location
Delete Deployed Software on a Device: Method: delete

Path: /iot/api/v2/devices/{device-id}/software/{id}
Retrieve Information about Multiple Endpoints: Method: get

Path: /iot/api/v2/devices
Retrieve Count of Devices: Method: get

Path: /iot/api/v2/devices/count
Retrieve List of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes
Retrieve count of common device metadata keys: Method: get

Path: /iot/api/v2/devices/metadataTypes/count
Retrieve Device Details: Method: get

Path: /iot/api/v2/devices/{device-id}
Retrieve the List of Applications or Adapters: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps
Retrieve an Application by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Retrieve Information about Multiple Devices: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/devices
Retrieve Metadata for Application with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}/metadata
Retrieve List of Devices which Belong to: Method: get

Path: /iot/api/v2/devices/{device-id}/devices
Retrieve Information about the Device Location: Method: get

Path: /iot/api/v2/devices/{device-id}/location
Get device activation logs: Method: get

Path: /iot/api/v2/devices/{device-id}/logs/activation
Retrieve a List of Artifacts of the Repository: Method: get

Path: /iot/api/v2/devices/{device-id}/software
Retrieve Software Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deleteRequests/{r-id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/deploymentRequests/{r-id}
Retrieve the Details of a Start Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Retrieve a Start Request Status with Details by Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests/{r-id}
Retrieve the Details of a Stop Request by Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Retrieve a Stop Request Status and Details with Specified Id: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests/{r-id}
Retrieve List of Software Requests: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests
Retrieve a Software Request Status with Details: Method: get

Path: /iot/api/v2/devices/{device-id}/software/{id}/updateRequests/{r-id}
Retrieve Metadata for Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata
Retrieve a Metadata Key for the Device with Specified Id: Method: get

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Create a new Device: Method: post

Path: /iot/api/v2/devices
Update a Device by ID: Method: post

Path: /iot/api/v2/devices/{device-id}
Update Application Details by Device Id: Method: post

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update Device Location with New Values: Method: post

Path: /iot/api/v2/devices/{device-id}/location
Deploy new Software on the Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software
Create Request to Start Deployed Software on a Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/startRequests
Create Request to Stop Deployed Software on Device: Method: post

Path: /iot/api/v2/devices/{device-id}/software/{id}/stopRequests
Update or Delete metadata for a Device by ID: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata
Set a Metadata Value for the Provided Key for the Device with Specified Id: Method: post

Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Update Device Information by ID: Method: put

Path: /iot/api/v2/devices/{device-id}
Update Device Details by Application Id: Method: put

Path: /iot/api/v2/devices/{device-id}/deviceApps/{app-id}
Update a Device Location with a new One: Method: put

Path: /iot/api/v2/devices/{device-id}/location
Update Software on the Device: Method: put

Path: /iot/api/v2/devices/{device-id}/software/{id}